home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / time / multiclock / multiclock.doc < prev    next >
Text File  |  1992-09-26  |  11KB  |  286 lines
  1.                         *** MultiClock ***
  2. Version 1.0
  3. -----------------------------------------------------------------
  4. © Hugh Leslie 1992
  5.  
  6. This program is FreeWare and may be freely distributed as long as
  7. no money is charged for it apart from a reasonable amount for
  8. copying and the cost of the media.  Please keep this distribution
  9. together.
  10. If you like this program and use it I would very much like to hear
  11. from you.
  12.  
  13. I can be reached at:
  14.  
  15. 9 Melville Road
  16. West Brunswick, 3068
  17. Melbourne
  18. Australia.
  19.  
  20. or
  21.  
  22. FidoNet - Amiga Central BBS, OZ. (3:633/353)
  23.  
  24.  
  25.  
  26. ** N.B. This program requires v2.0 or greater Operating System **
  27.  
  28.  
  29. MultiClock is a simple titlebar clock commodity with lots of
  30. flexibility and many extra features such as:
  31.  
  32. *   A very flexible format for the clock which allows you to show
  33.     the time and date in virtually any way you like. Also will
  34.     display memory, the type of processor you are running, and
  35.     all this in as    many colours as you want.
  36.  
  37. *   The ability to speak the time using digitised speech or the
  38.     inbuilt narrator device.
  39.  
  40. *   Chimes using inbuilt or digitised sounds on the hour, half
  41.     hour or quarter hour.
  42.  
  43. *   An alarm which again allows you to use inbuilt or digitised
  44.     sounds and also launch a batch or Arexx file on an Alarm.
  45.  
  46. -----------------------------------------------------------------
  47. -Running the program.-
  48. -----------------------------------------------------------------
  49.  
  50. The program is run from Workbench by clicking on the icon or
  51. simply by putting it in your WorkbenchStartup drawer.  It can be
  52. run from the CLI by specifying tooltypes as arguments.
  53.  
  54. ToolTypes: CX_POPUP=YES          Pops control window up
  55.                                  immediately.
  56.                                  Defaults to NO.
  57.  
  58.            CX_PRIORITY=n         Where n  is priority to run at.
  59.                                  Default is 0.
  60.  
  61.            CX_POPKEY=string      ie alt f10 - Hotkey to pop
  62.                                  control window up with.
  63.                                  Default = control f10
  64.  
  65.            HIDE_CLOCKKEY=string  Hotkey to toggle clock on
  66.                                  & off screen - useful if
  67.                                  changing screen prefs so
  68.                                  that you dont have to
  69.                                  close the program down.
  70.  
  71.            SAY_TIMEKEY=string    Hotkey to say time in
  72.                                  current mode.
  73.  
  74.            DONOTWAIT             Standard commodity command
  75.                                  to tell WorkBench not to
  76.                                  wait for the program to
  77.                                  finish.
  78.  
  79.            CLOCKCONFIG=string    This is where you may
  80.                                  define what you want your
  81.                                  clock to look like. See below.
  82.  
  83.  
  84. -----------------------------------------------------------------
  85. -Configuring the clock.-
  86. -----------------------------------------------------------------
  87. On starting the clock you will see a default time and date in the
  88. title bar of your workbench screen.  This can easily be changed on
  89. the fly by activating the program window either through its HotKey
  90. (which defaults to control f10) or via the commodities exchange
  91. program.
  92.  
  93. When this window is activated you will see a large text gadget
  94. with a clear button at the end.  Any text you type in this gadget
  95. will be displayed as is in the title bar, however the clock
  96. understands a number of codes which are inserted by putting them
  97. between <>.  These
  98. codes are as follows.
  99.  
  100.  
  101.     <MC>     Inserts chip memory in K
  102.     <MF>     Inserts fast memory in K
  103.     <MT>     Inserts total memory in K
  104.  
  105.     <Hn>     Inserts Hour - n is either:     1 = 12 hour clock
  106.                                          or 2 = 24 hour clock.
  107.     <NM>     Inserts Minutes.
  108.     <SS>     Inserts Seconds.
  109.  
  110.     <Fc>     Inserts flashing character where c is any single
  111.              character.
  112.              Flashes at 1 second interval.
  113.  
  114.     <PM>     Inserts 'AM' or 'PM' depending on time of day.
  115.              Lower case will give lower case letters and
  116.              uppercase upper.
  117.  
  118.     <Dn>     Inserts Day of the week.
  119.              n is either:   1 = 3 character day ie "Mon"
  120.                   or        2 = Full name ie "Monday".
  121.  
  122.     <DT>     Inserts a 2 digit date (ie day of month).
  123.     <TH>     Inserts 'st', 'nd', 'rd', or 'th' depending on the
  124.              date. ie if the date is 12 then <TH> will give 'th'
  125.              but if 2 it will give 'nd'.
  126.  
  127.     <On>     Inserts Month. n is one of:
  128.                1 = numerical date with leading zero suppressed.
  129.                2 = 3 character month ie "Jun"
  130.                3 = Full name ie "June".
  131.  
  132.     <YY>     Inserts 2 digit year.
  133.  
  134.     <Cn> or <Cnn> will change the rendering colour to colour n
  135.              or nn.
  136.  
  137.     <PR>     Inserts processor as in '680x0'
  138.  
  139.  
  140.        The default Config is -
  141.  
  142.        "<D2> <DT><TH> <O3> 19<YY>  <H1><C2><F:><C0><NM> <pm>"
  143.  
  144.        Tonight this gives  - Monday 8th June 1992  11:32 pm
  145.                                                      ^
  146.                                                      |
  147.                                                note ':' is
  148.                                  flashing a different colour.
  149.  
  150.        <DT>/<O1>/<YY>  would give 8/6/92
  151.  
  152.        Any text not between <> will be printed as is.
  153.  
  154. -----------------------------------------------------------------
  155. -Chime Window-
  156. -----------------------------------------------------------------
  157. On the main window is a button called Chime.  This button will
  158. take you to the Chime set up window.
  159.  
  160. This panel allows you to set up a "chime" to occur at hourly,
  161. 1/2 hourly, or 1/4 hourly intervals.  The chime can be one of:
  162.  
  163. Simple "Beep".
  164. Three Beeps starting 3 seconds before the actual time.
  165. A sampled sound.
  166. The anouncement of the time.
  167.  
  168. All of these can be selected by simply clicking on the cycle
  169. gadgets to show the one you want.
  170.  
  171. When you select a sampled sound you can then select the "Load
  172. Sample" button and through the file requestor select a sample to
  173. load.
  174.  
  175. The file name is shown in the text box without its pathname,
  176. however the program will remember this pathname when you next
  177. start it.  If you move the program without reselecting the path
  178. then the program may not be able to find your sample.  Just
  179. reselect it if this happens.
  180.  
  181. You can test any of these sounds by clicking on the "Test Sound"
  182. button.
  183.  
  184. Selecting OK will put these changes into use otherwise selecting
  185. cancel will revert to the previous options.
  186.  
  187. NB.  TO TURN ON THE CHIME YOU MUST SELECT THE "CHIME ON" GADGET IN
  188.     THE MAIN WINDOW.
  189.  
  190. ------------------------------------------------------------------
  191. -Alarm Window-
  192. ------------------------------------------------------------------
  193. Selecting the Alarm button will bring up the Alarm window.
  194.  
  195. This window is divided into three main areas:
  196.  
  197. 1.  The time select area has two sliders and a time display
  198. gadget. This allows you to select a time for the alarm to sound
  199. which is accurate to the second.
  200.  
  201. 2.  The sound area - this allows you to select the type of sound
  202. you would like the program to produce when the Alarm time is
  203. reached.  The selection process is exectly the same as for the
  204. chime window.
  205.  
  206. The Alarm sound takes precedence over the Chime sound.
  207.  
  208. 3.  The event area.  This allows you to select an Arexx program
  209. or Batch file to launch when the alarm time is reached.  Just
  210. select the type of event you want, and then type in or load the
  211. batch or arexx program you want to run.  The program will open a
  212. console window ONLY if the program runnning needs to produce some
  213. output.
  214.  
  215. NB.  TO TURN ON THE ALARM YOU MUST SELECT THE "ALARM ON" GADGET IN
  216.      THE MAIN WINDOW.
  217.  
  218. -----------------------------------------------------------------
  219. -Talk Options Window-
  220. -----------------------------------------------------------------
  221. Selecting the Talk Options button will bring up the Talk Options
  222. window.
  223.  
  224. This panel allows you to select between:
  225.  
  226. 1. Internal speech ie speech produced by the Amigas own Narrator
  227. device.  When this option is selected you must tell the program
  228. where to find the Data file.  The default place to find it is
  229. ENVARC:MultiClock/MultiClock.talkdata
  230.  
  231. This file is simply a text file with numbers in the narrator
  232. devices phoneme format.  This can be edited to make them sound
  233. better or different.  The only thing is that they must be in the
  234. same order and they must be valid phonemes.
  235.  
  236. A few of the Narrator device options can be selected from this
  237. panel, but not all.  (Under WB 2.0 there are about 20 different
  238. options that can be changed!)  You can change the sex of the voice
  239. with one cycle gadget and from a natural voice to a robotic voice
  240. with the other.  This also gives you the option of a "manual"
  241. voice.  This treats the emphasis on phonemes without regard to
  242. their surrounding phonemes and thus enables you to more easily get
  243. the effect you want by changing the emphasis on some syllables.
  244. The slider gadgets give you control over pitch and rate and the
  245. default settings button changes everything back to the system
  246. default values.
  247.  
  248. 2. Sampled speech is produced by stringing together sound samples
  249. which are in standard IFF 8SVX format.  There is no reason why you
  250. cannot use your own voice, the only requirement is that the sound
  251. samples must be named as the ones in the release are, for the
  252. program to find them properly, and they must be less than 102400
  253. bytes long!
  254.  
  255. To use this option you must select the directory in which the
  256. sound samples reside.  This defaults to ENVARC:MultiClock/Sounds
  257.  
  258. The "Test Voice" button will say the current time using the
  259. current settings.
  260.  
  261. Again, the OK button will set the current settings for use and the
  262. cancel button will go back to the previous settings.
  263.  
  264. -----------------------------------------------------------------
  265. -Load/Save Config-
  266. -----------------------------------------------------------------
  267. The Load Config and Save Config buttons will load or save the
  268. entire configuration of the clock.  The default directory for
  269. saving config files is ENVARC:MultiClock.  If the program detects
  270. a file called MultiClock.config in this directory at startup it
  271. will automatically load and use this config file.  At any time you
  272. can load another config file and these files can have any name.
  273.  
  274. -----------------------------------------------------------------
  275. -Hide & Quit-
  276. -----------------------------------------------------------------
  277. The Hide button will close the Clock window but leave the clock
  278. itself running.  The Quit button will close the clock down
  279. completely.  These buttons have the keyboard equivalents 'H' and
  280. 'Q' respectively.
  281.  
  282. -----------------------------------------------------------------
  283. -Thanks-
  284. -----------------------------------------------------------------
  285. Thanks to Simon Shead for his work in Beta testing this program
  286. and also to Rohan Safstrom and Gary Gajic.